<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Swift_Message_Mime</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Swift_Message_Mime</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Mime is the underbelly for Messages, Attachments, Parts, Embedded Images, Forwarded Mail, etc</p>
<p class="description"><p>In fact, every single component of the composed email is simply a new Mime document nested inside another  When you piece an email together in this way you see just how straight-forward it really is</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Chris Corbyn &lt;<a href="mailto:chris@w3style.co.uk">chris@w3style.co.uk</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Swift---Message---Mime.php.html">/Swift/Message/Mime.php</a> (line <span class="field">33</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Swift_Message/Swift_Message_Attachment.html">Swift_Message_Attachment</a></td>
					<td>
											Attachment component for Swift Mailer
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Swift_Message/Swift_Message_Part.html">Swift_Message_Part</a></td>
					<td>
											MIME Part body component for Swift Mailer
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../Swift_Message/Swift_Message.html">Swift_Message</a></td>
					<td>
											Swift Message class
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																																																								<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$boundary" title="details" class="var-name">$boundary</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Swift_Cache/Swift_Cache.html">Swift_Cache</a></span>
					<a href="#$cache" title="details" class="var-name">$cache</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$children" title="details" class="var-name">$children</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$data" title="details" class="var-name">$data</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Swift_Message/Swift_Message_Headers.html">Swift_Message_Headers</a></span>
					<a href="#$headers" title="details" class="var-name">$headers</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$HTML" title="details" class="var-name">$HTML</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$LE" title="details" class="var-name">$LE</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$MISC" title="details" class="var-name">$MISC</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$PLAIN" title="details" class="var-name">$PLAIN</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$SAFE_LENGTH" title="details" class="var-name">$SAFE_LENGTH</a>
				</div>
																<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$VERY_SAFE_LENGTH" title="details" class="var-name">$VERY_SAFE_LENGTH</a>
				</div>
																<div class="var-title">
					<span class="var-type">int</span>
					<a href="#$wrap" title="details" class="var-name">$wrap</a>
				</div>
																<div class="var-title">
					<span class="var-type"><a href="../Swift_Message/Swift_Message_Encoder.html">Swift_Message_Encoder</a></span>
					<a href="#$_encoder" title="details" class="var-name">$_encoder</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																																																																																																												
												<div class="method-definition">
											<span class="method-result">Swift_Message_Mime</span>
										<a href="#Swift_Message_Mime" title="details" class="method-name">Swift_Message_Mime</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#addChild" title="details" class="method-name">addChild</a>
											(<span class="var-type"><a href="../Swift_Message/Swift_Message_Mime.html">Swift_Message_Mime</a></span>&nbsp;<span class="var-name">&$mime</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$after</span> = <span class="var-default">1</span>])
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Swift_Cache/Swift_Cache_OutputStream.html">Swift_Cache_OutputStream</a></span>
										<a href="#build" title="details" class="method-name">&amp;build</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Swift_Cache/Swift_Cache_OutputStream.html">Swift_Cache_OutputStream</a></span>
										<a href="#buildData" title="details" class="method-name">&amp;buildData</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#generateBoundary" title="details" class="method-name">generateBoundary</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../Swift_Message/Swift_Message_Mime.html">Swift_Message_Mime</a></span>
										<a href="#getChild" title="details" class="method-name">&amp;getChild</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getContentType" title="details" class="method-name">getContentType</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string,Swift_File</span>
										<a href="#getData" title="details" class="method-name">&amp;getData</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getEncoding" title="details" class="method-name">getEncoding</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getLE" title="details" class="method-name">getLE</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getLevel" title="details" class="method-name">getLevel</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#hasChild" title="details" class="method-name">hasChild</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#listChildren" title="details" class="method-name">listChildren</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">int</span>
										<a href="#numChildren" title="details" class="method-name">numChildren</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#preBuild" title="details" class="method-name">preBuild</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeChild" title="details" class="method-name">removeChild</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setContentType" title="details" class="method-name">setContentType</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setData" title="details" class="method-name">setData</a>
											(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setEncoding" title="details" class="method-name">setEncoding</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$non_ascii</span> = <span class="var-default">false</span>])
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setHeaders" title="details" class="method-name">setHeaders</a>
											(<span class="var-type"><a href="../Swift_Message/Swift_Message_Headers.html">Swift_Message_Headers</a></span>&nbsp;<span class="var-name">&$headers</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#setLE" title="details" class="method-name">setLE</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$le</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setLineWrap" title="details" class="method-name">setLineWrap</a>
											(<span class="var-type">int</span>&nbsp;<span class="var-name">$len</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#uncacheAll" title="details" class="method-name">uncacheAll</a>
										()
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$boundary" id="$boundary"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$boundary</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">79</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The boundary used to separate mime parts</p>
	
	
		
		

</div>
<a name="var$cache" id="$cache"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Swift_Cache/Swift_Cache.html">Swift_Cache</a></span>
			<span class="var-name">$cache</span>
						(line <span class="line-number">94</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An instance of Swift_Cache</p>
	
	
		
		

</div>
<a name="var$children" id="$children"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$children</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">74</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Nested mime parts</p>
	
	
		
		

</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$data</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">64</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The body of the documented (unencoded)</p>
	<ul class="tags">
				<li><span class="field">var:</span> data</li>
			</ul>
	
	
		
		

</div>
<a name="var$headers" id="$headers"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Swift_Message/Swift_Message_Headers.html">Swift_Message_Headers</a></span>
			<span class="var-name">$headers</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">59</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The header part of this MIME document</p>
	
	
		
		

</div>
<a name="var$HTML" id="$HTML"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$HTML</span>
			 = <span class="var-default"> SWIFT_MIME_HTML</span>			(line <span class="line-number">42</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant for HTML emails</p>
	
	
		
		

</div>
<a name="var$LE" id="$LE"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$LE</span>
			 = <span class="var-default"> &quot;\r\n&quot;</span>			(line <span class="line-number">84</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The line ending characters needed</p>
	
	
		
		

</div>
<a name="var$MISC" id="$MISC"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$MISC</span>
			 = <span class="var-default"> SWIFT_MIME_MISC</span>			(line <span class="line-number">46</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant for miscellaneous mime type</p>
	
	
		
		

</div>
<a name="var$PLAIN" id="$PLAIN"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$PLAIN</span>
			 = <span class="var-default"> SWIFT_MIME_PLAIN</span>			(line <span class="line-number">38</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant for plain-text emails</p>
	
	
		
		

</div>
<a name="var$SAFE_LENGTH" id="$SAFE_LENGTH"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$SAFE_LENGTH</span>
			 = <span class="var-default"> SWIFT_MIME_SAFELENGTH</span>			(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant for safe line length in almost all places</p>
	
	
		
		

</div>
<a name="var$VERY_SAFE_LENGTH" id="$VERY_SAFE_LENGTH"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$VERY_SAFE_LENGTH</span>
			 = <span class="var-default"> SWIFT_MIME_VERYSAFELENGTH</span>			(line <span class="line-number">54</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constant for really safe line length</p>
	
	
		
		

</div>
<a name="var$wrap" id="$wrap"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">int</span>
			<span class="var-name">$wrap</span>
			 = <span class="var-default"> SWIFT_MIME_SAFELENGTH</span>			(line <span class="line-number">69</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Maximum line length</p>
	
	
		
		

</div>
<a name="var$_encoder" id="$_encoder"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../Swift_Message/Swift_Message_Encoder.html">Swift_Message_Encoder</a></span>
			<span class="var-name">$_encoder</span>
						(line <span class="line-number">89</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An instance of the encoder</p>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="methodSwift_Message_Mime" id="Swift_Message_Mime"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor Swift_Message_Mime</span> (line <span class="line-number">99</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
	
	<div class="method-signature">
		<span class="method-result">Swift_Message_Mime</span>
		<span class="method-name">
			Swift_Message_Mime
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodaddChild" id="addChild"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">addChild</span> (line <span class="line-number">391</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Nest a child mime part in this document</p>
	<ul class="tags">
				<li><span class="field">return:</span> The identifier for this part</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			addChild
		</span>
					(<span class="var-type"><a href="../Swift_Message/Swift_Message_Mime.html">Swift_Message_Mime</a></span>&nbsp;<span class="var-name">&$mime</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type">int</span>&nbsp;<span class="var-name">$after</span> = <span class="var-default">1</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Message/Swift_Message_Mime.html">Swift_Message_Mime</a></span>
				<span class="var-name">&$mime</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The identifier to use, optional</span>			</li>
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$after</span><span class="var-description">: Add the part before (-1) or after (+1) the other parts</span>			</li>
				</ul>
		
			
	</div>
<a name="methodbuild" id="build"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">build</span> (line <span class="line-number">484</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Compile the entire MIME document into a string  The returned string may be used in other documents if needed.</p>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Swift_Cache/Swift_Cache_OutputStream.html">Swift_Cache_OutputStream</a></span>
		<span class="method-name">
			&amp;build
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodbuildData" id="buildData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">buildData</span> (line <span class="line-number">270</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the data in the format suitable for sending</p>
	<ul class="tags">
				<li><span class="field">throws:</span> Swift_FileException If the file stream given cannot be read</li>
				<li><span class="field">throws:</span> Swift_Message_MimeException If some required headers have been forcefully removed</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Swift_Cache/Swift_Cache_OutputStream.html">Swift_Cache_OutputStream</a></span>
		<span class="method-name">
			&amp;buildData
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgenerateBoundary" id="generateBoundary"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">generateBoundary</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Compute a unique boundary</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			generateBoundary
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetChild" id="getChild"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getChild</span> (line <span class="line-number">436</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get a child document, identified by $id</p>
	<ul class="tags">
				<li><span class="field">return:</span> The child document</li>
				<li><span class="field">throws:</span> Swift_Message_MimeException If no such child exists</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result"><a href="../Swift_Message/Swift_Message_Mime.html">Swift_Message_Mime</a></span>
		<span class="method-name">
			&amp;getChild
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The identifier for this child</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetContentType" id="getContentType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getContentType</span> (line <span class="line-number">192</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the content type which has been set</p>
<p class="description"><p>The MIME 1.0 Content-Type is provided as a string</p></p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getContentType
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetData" id="getData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getData</span> (line <span class="line-number">260</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the string which makes up the body of this MIME document</p>
	
	<div class="method-signature">
		<span class="method-result">string,Swift_File</span>
		<span class="method-name">
			&amp;getData
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetEncoding" id="getEncoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getEncoding</span> (line <span class="line-number">240</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the encoding format used in this document</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getEncoding
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLE" id="getLE"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getLE</span> (line <span class="line-number">160</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the line ending sequence</p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getLE
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLevel" id="getLevel"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLevel</span> (line <span class="line-number">478</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the level at which this mime part would appear in a document</p>
<p class="description"><p>One of &quot;mixed&quot;, &quot;alternative&quot; or &quot;related&quot;</p></p>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			getLevel
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Swift_Message/Swift_Message_Attachment.html#methodgetLevel">Swift_Message_Attachment::getLevel()</a>
								: Get the level in the MIME hierarchy at which this section should appear.
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message_EmbeddedFile.html#methodgetLevel">Swift_Message_EmbeddedFile::getLevel()</a>
								: Get the level in the MIME hierarchy at which this section should appear.
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message_Part.html#methodgetLevel">Swift_Message_Part::getLevel()</a>
								: Get the level in the MIME hierarchy at which this section should appear.
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message.html#methodgetLevel">Swift_Message::getLevel()</a>
								: Get the level in the MIME hierarchy at which this section should appear.
							</li>
				</ul>
	</div>
<a name="methodhasChild" id="hasChild"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">hasChild</span> (line <span class="line-number">426</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Check if a child exists identified by $id</p>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			hasChild
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: Identifier to look for</span>			</li>
				</ul>
		
			
	</div>
<a name="methodlistChildren" id="listChildren"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">listChildren</span> (line <span class="line-number">461</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">List the IDs of all children in this document</p>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			listChildren
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodnumChildren" id="numChildren"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">numChildren</span> (line <span class="line-number">469</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the total number of children present in this document</p>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			numChildren
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodpreBuild" id="preBuild"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">preBuild</span> (line <span class="line-number">504</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Execute any logic needed prior to building (abstract)</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			preBuild
		</span>
				()
			</div>
	
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Swift_Message/Swift_Message_Attachment.html#methodpreBuild">Swift_Message_Attachment::preBuild()</a>
								: Execute needed logic prior to building
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message_Part.html#methodpreBuild">Swift_Message_Part::preBuild()</a>
								: Pre-compilation logic
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message.html#methodpreBuild">Swift_Message::preBuild()</a>
								: Execute needed logic prior to compilation
							</li>
				</ul>
	</div>
<a name="methodremoveChild" id="removeChild"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">removeChild</span> (line <span class="line-number">452</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove a part from the document</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			removeChild
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$id</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$id</span><span class="var-description">: The identifier of the child</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetContentType" id="setContentType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setContentType</span> (line <span class="line-number">183</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the content type of this MIME document</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setContentType
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$type</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$type</span><span class="var-description">: The content type to use in the same format as MIME 1.0 expects</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetData" id="setData"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setData</span> (line <span class="line-number">250</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Specify the string which makes up the body of this message  HINT: You can always nest another MIME document here if you call it's build() method.</p>
<p class="description"><p>$data can be an object of Swift_File or a string</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setData
		</span>
					(<span class="var-type">mixed</span>&nbsp;<span class="var-name">$data</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$data</span><span class="var-description">: The body of the document</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../Swift_Message/Swift_Message_Attachment.html#methodsetData">Swift_Message_Attachment::setData()</a>
								: Overrides setData() in MIME so that a filename can be set
							</li>
					<li>
				<a href="../Swift_Message/Swift_Message_Image.html#methodsetData">Swift_Message_Image::setData()</a>
								: Set data for the image
							</li>
				</ul>
	</div>
<a name="methodsetEncoding" id="setEncoding"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setEncoding</span> (line <span class="line-number">202</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the encoding format to be used on the body of the document</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setEncoding
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$encoding</span>, [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$recursive</span> = <span class="var-default">false</span>], [<span class="var-type">boolean</span>&nbsp;<span class="var-name">$non_ascii</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$encoding</span><span class="var-description">: The encoding type used</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$recursive</span><span class="var-description">: If this encoding format should be used recursively. Note, this only takes effect if no encoding is set in the children.</span>			</li>
					<li>
				<span class="var-type">boolean</span>
				<span class="var-name">$non_ascii</span><span class="var-description">: If the encoding should only be applied when the string is not ascii.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetHeaders" id="setHeaders"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setHeaders</span> (line <span class="line-number">130</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Replace the current headers with new ones</p>
<p class="description"><p>DO NOT DO THIS UNLESS YOU KNOW WHAT YOU'RE DOING!</p></p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setHeaders
		</span>
					(<span class="var-type"><a href="../Swift_Message/Swift_Message_Headers.html">Swift_Message_Headers</a></span>&nbsp;<span class="var-name">&$headers</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Swift_Message/Swift_Message_Headers.html">Swift_Message_Headers</a></span>
				<span class="var-name">&$headers</span><span class="var-description">: The headers to use</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLE" id="setLE"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setLE</span> (line <span class="line-number">139</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the line ending character to use</p>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			setLE
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$le</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$le</span><span class="var-description">: The line ending sequence</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLineWrap" id="setLineWrap"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setLineWrap</span> (line <span class="line-number">379</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the size at which lines wrap around (includes the CRLF)</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setLineWrap
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$len</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$len</span><span class="var-description">: The length of a line</span>			</li>
				</ul>
		
			
	</div>
<a name="methoduncacheAll" id="uncacheAll"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">uncacheAll</span> (line <span class="line-number">167</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Reset the entire cache state from this branch of the tree and traversing down through the children</p>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			uncacheAll
		</span>
				()
			</div>
	
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Wed, 26 Mar 2008 20:33:49 +1100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.1</a>
	</p>
	</div></body>
</html>